1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
use std::any::Any;
use std::marker::PhantomPinned;
use std::pin::Pin;
use std::sync::Arc;
use crate::co;
use crate::decl::*;
use crate::gui::{*, events::*, privs::*};
use crate::msg::*;
use crate::prelude::*;
struct Obj { // actual fields of CheckBox
base: BaseNativeControl,
events: ButtonEvents,
_pin: PhantomPinned,
}
//------------------------------------------------------------------------------
/// Native
/// [check box](https://learn.microsoft.com/en-us/windows/win32/controls/button-types-and-styles#check-boxes)
/// control, actually a variation of the ordinary
/// [`Button`](crate::gui::Button): just a button with a specific style.
#[derive(Clone)]
pub struct CheckBox(Pin<Arc<Obj>>);
unsafe impl Send for CheckBox {}
impl AsRef<BaseNativeControl> for CheckBox {
fn as_ref(&self) -> &BaseNativeControl {
&self.0.base
}
}
impl GuiWindow for CheckBox {
fn hwnd(&self) -> &HWND {
self.0.base.hwnd()
}
fn as_any(&self) -> &dyn Any {
self
}
}
impl GuiWindowText for CheckBox {}
impl GuiChild for CheckBox {
fn ctrl_id(&self) -> u16 {
self.0.base.ctrl_id()
}
}
impl GuiChildFocus for CheckBox {}
impl GuiNativeControl for CheckBox {}
impl GuiNativeControlEvents<ButtonEvents> for CheckBox {
fn on(&self) -> &ButtonEvents {
if *self.hwnd() != HWND::NULL {
panic!("Cannot add events after the control creation.");
} else if *self.0.base.parent().hwnd() != HWND::NULL {
panic!("Cannot add events after the parent window creation.");
}
&self.0.events
}
}
impl CheckBox {
/// Instantiates a new `CheckBox` object, to be created on the parent window
/// with
/// [`HWND::CreateWindowEx`](crate::prelude::user_Hwnd::CreateWindowEx).
///
/// # Panics
///
/// Panics if the parent window was already created – that is, you cannot
/// dynamically create a `CheckBox` in an event closure.
#[must_use]
pub fn new(parent: &impl GuiParent, opts: CheckBoxOpts) -> Self {
let opts = auto_ctrl_id_if_zero(opts);
let ctrl_id = opts.ctrl_id;
let new_self = Self(
Arc::pin(
Obj {
base: BaseNativeControl::new(parent, ctrl_id),
events: ButtonEvents::new(parent, ctrl_id),
_pin: PhantomPinned,
},
),
);
let self2 = new_self.clone();
parent.as_ref().before_user_on().wm_create_or_initdialog(move |_, _| {
self2.create(OptsResz::Wnd(&opts))?;
Ok(WmRet::NotHandled)
});
new_self
}
/// Instantiates a new `CheckBox` object, to be loaded from a dialog
/// resource with
/// [`HWND::GetDlgItem`](crate::prelude::user_Hwnd::GetDlgItem).
///
/// # Panics
///
/// Panics if the parent dialog was already created – that is, you cannot
/// dynamically create a `CheckBox` in an event closure.
#[must_use]
pub fn new_dlg(
parent: &impl GuiParent,
ctrl_id: u16,
resize_behavior: (Horz, Vert),
) -> Self
{
let new_self = Self(
Arc::pin(
Obj {
base: BaseNativeControl::new(parent, ctrl_id),
events: ButtonEvents::new(parent, ctrl_id),
_pin: PhantomPinned,
},
),
);
let self2 = new_self.clone();
parent.as_ref().before_user_on().wm(co::WM::INITDIALOG, move |_, _| {
self2.create(OptsResz::Dlg(resize_behavior))?;
Ok(WmRet::NotHandled)
});
new_self
}
fn create(&self, opts_resz: OptsResz<&CheckBoxOpts>) -> SysResult<()> {
match opts_resz {
OptsResz::Wnd(opts) => {
let mut pos = POINT::new(opts.position.0, opts.position.1);
multiply_dpi_or_dtu(
self.0.base.parent(), Some(&mut pos), None)?;
let mut sz = SIZE::new(opts.size.0 as _, opts.size.1 as _);
if sz.cx == -1 && sz.cy == -1 {
sz = calc_text_bound_box_check(&opts.text)?; // resize to fit text
} else {
multiply_dpi_or_dtu(
self.0.base.parent(), None, Some(&mut sz))?; // user-defined size
}
self.0.base.create_window(
"BUTTON", Some(&opts.text), pos, sz,
opts.window_ex_style,
opts.window_style | opts.button_style.into(),
)?;
unsafe {
self.hwnd().SendMessage(wm::SetFont {
hfont: ui_font(),
redraw: true,
});
}
if opts.check_state != CheckState::Unchecked {
self.set_check_state(opts.check_state);
}
},
OptsResz::Dlg(_) => self.0.base.create_dlg()?,
}
self.0.base.parent()
.add_to_layout_arranger(self.hwnd(), opts_resz.resize_behavior())
}
/// Retrieves the current check state by sending a
/// [`bm::GetCheck`](crate::msg::bm::GetCheck) message.
#[must_use]
pub fn check_state(&self) -> CheckState {
match unsafe { self.hwnd().SendMessage(bm::GetCheck {}) } {
co::BST::CHECKED => CheckState::Checked,
co::BST::INDETERMINATE => CheckState::Indeterminate,
_ => CheckState::Unchecked,
}
}
/// Emulates the click event for the check box by sending a
/// [`bm::Click`](crate::msg::bm::Click) message.
pub fn emulate_click(&self) {
unsafe { self.hwnd().SendMessage(bm::Click {}); }
}
/// Calls [`check_state`](crate::gui::CheckBox::check_state) and compares
/// the result with
/// [`CheckState::Checked`](crate::gui::CheckState::Checked).
#[must_use]
pub fn is_checked(&self) -> bool {
self.check_state() == CheckState::Checked
}
/// Sets the current check state by sending a
/// [`bm::SetCheck`](crate::msg::bm::SetCheck) message.
pub fn set_check_state(&self, state: CheckState) {
unsafe {
self.hwnd().SendMessage(bm::SetCheck {
state: match state {
CheckState::Checked => co::BST::CHECKED,
CheckState::Indeterminate => co::BST::INDETERMINATE,
CheckState::Unchecked => co::BST::UNCHECKED,
},
});
}
}
/// Sets the current check state by sending a
/// [`bm::SetCheck`](crate::msg::bm::SetCheck) message, then sends a
/// [`wm::Command`](crate::msg::wm::Command) message to the parent, so it
/// can handle the event.
pub fn set_check_state_and_trigger(&self, state: CheckState) {
self.set_check_state(state);
unsafe {
self.hwnd().GetParent().unwrap().SendMessage(
wm::Command {
event: AccelMenuCtrl::Ctrl(
AccelMenuCtrlData {
notif_code: co::BN::CLICKED.into(),
ctrl_id: self.ctrl_id(),
ctrl_hwnd: self.hwnd().raw_copy(),
},
),
},
);
}
}
/// Calls [`set_text`](crate::prelude::GuiWindowText::set_text) and resizes
/// the control to exactly fit the new text.
pub fn set_text_and_resize(&self, text: &str) {
self.set_text(text);
let bound_box = calc_text_bound_box_check(text).unwrap();
self.hwnd().SetWindowPos(
HwndPlace::None, POINT::default(), bound_box,
co::SWP::NOZORDER | co::SWP::NOMOVE).unwrap();
}
}
//------------------------------------------------------------------------------
/// Options to create a [`CheckBox`](crate::gui::CheckBox) programmatically with
/// [`CheckBox::new`](crate::gui::CheckBox::new).
pub struct CheckBoxOpts {
/// Text of the control to be
/// [created](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-createwindowexw).
///
/// Defaults to empty string.
pub text: String,
/// Left and top position coordinates of control within parent's client
/// area, to be
/// [created](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-createwindowexw).
///
/// If the parent window is a dialog, the values are in Dialog Template
/// Units; otherwise in pixels, which will be multiplied to match current
/// system DPI.
///
/// Defaults to `(0, 0)`.
pub position: (i32, i32),
/// Width and height of control to be
/// [created](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-createwindowexw).
///
/// If the parent window is a dialog, the values are in Dialog Template
/// Units; otherwise in pixels, which will be multiplied to match current
/// system DPI.
///
/// Defaults to the size needed to fit the text.
pub size: (u32, u32),
/// Check box styles to be
/// [created](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-createwindowexw).
///
/// Defaults to `BS::AUTOCHECKBOX`.
///
/// Suggestions:
/// * replace with `BS::AUTO3STATE` for a 3-state check box.
pub button_style: co::BS,
/// Window styles to be
/// [created](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-createwindowexw).
///
/// Defaults to `WS::CHILD | WS::VISIBLE | WS::TABSTOP | WS::GROUP`.
pub window_style: co::WS,
/// Extended window styles to be
/// [created](https://learn.microsoft.com/en-us/windows/win32/api/winuser/nf-winuser-createwindowexw).
///
/// Defaults to `WS_EX::LEFT`.
pub window_ex_style: co::WS_EX,
/// The control ID.
///
/// Defaults to an auto-generated ID.
pub ctrl_id: u16,
/// Horizontal and vertical behavior of the control when the parent window
/// is resized.
///
/// Defaults to `(gui::Horz::None, gui::Vert::None)`.
pub resize_behavior: (Horz, Vert),
/// Initial check state.
///
/// Defaults to `gui::CheckState::Unchecked`.
pub check_state: CheckState,
}
impl Default for CheckBoxOpts {
fn default() -> Self {
Self {
text: "".to_owned(),
position: (0, 0),
size: (-1i32 as _, -1i32 as _), // will resize to fit the text
button_style: co::BS::AUTOCHECKBOX,
window_style: co::WS::CHILD | co::WS::VISIBLE | co::WS::TABSTOP | co::WS::GROUP,
window_ex_style: co::WS_EX::LEFT,
ctrl_id: 0,
resize_behavior: (Horz::None, Vert::None),
check_state: CheckState::Unchecked,
}
}
}
impl ResizeBehavior for &CheckBoxOpts {
fn resize_behavior(&self) -> (Horz, Vert) {
self.resize_behavior
}
}
impl AutoCtrlId for CheckBoxOpts {
fn ctrl_id_mut(&mut self) -> &mut u16 {
&mut self.ctrl_id
}
}